Bundle org.nuxeo.ecm.automation.scripting

In bundle group org.nuxeo.ecm.automation

Documentation

Readme.md

About

This module is a work in progress for allowing to use JavaScript

as an Automation based DSL to write custom extensions
to create "Automation chains"

Motivations

The initial idea comes from the following constations :

Automation Operations are a good High Level API : people succeed is doing amazing stuffs with it
Automation Chain control flow is too primitive
- loops are complex
- conditions are complex
- reusing "code segment" forces using several chains and makes maintenability more complex

So, the idea is to use a simple scripting language to manage the control flow and give accees to the Automation API.

Example :

Here is a example of an Automation Script :

var root = Document.Fetch(null, {
    "value": "/"
});

var newDocs = [];
for (var i = 1; i < 10; i++) {

    var newDoc = Document.Create(root, {
        "type": "File",
        "name": "newDoc" + i,
        "properties": {
            "dc:title": "New Title" + i,
            "dc:source": "JavaScript",
            "dc:subjects": ["from", "javascript"]
        }
    });
    var lastUUIDDigit = parseInt(newDoc.getId().slice(-1));
    if (lastUUIDDigit % 2 == 0) {
        newDoc = Document.Update(newDoc, {
            "properties": {
                "dc:nature": "even"
            }
        });
    } else {
        newDoc = Document.Update(newDoc, {
            "properties": {
                "dc:nature": "odd"
            }
        });
    }
    newDocs.push(newDoc);
}

var evenDocs = Document.Query(null, {
    "query": "select * from Document where dc:nature='even'"
});

println("Created " + evenDocs.size() + " even Documents");

Here is an exemple of an "Automation Chain" defined via a script

  <scriptedOperation id="Scripting.AddFacetInSubTree">
     <inputType>Document</inputType>
     <outputType>Documents</outputType>
     <param name="facet" type="string"/>
     <param name="type" type="string"/>

     <script><![CDATA[
       function run(ctx, input, params) {

         var query = "select * from " + params.type + " where ecm:path startswith '";
         query = query + input.getPathAsString();
         query = query + "'";

         //println("query = " + query);
         var subDocs = Document.Query(null, {
		"query": query
	   });

	   //println("Query run with " + subDocs.size() + " result");

	   var updated = [];
	   for (var i = 0; i < subDocs.size(); i++) {
	      var doc = subDocs.get(i);
	      if (!doc.hasFacet(params.facet)) {
	         doc.addFacet(params.facet);
	         updated.push(Document.Save(doc,{}));
	      }
	   }
         return updated;
       }
       ]]>
     </script>
  </scriptedOperation>

Resolution Order

[69, 808]

The resolution order represents the order in which components have been resolved by the Nuxeo Runtime framework. This range represents the minimal and maximal orders for this bundle's components.
You can influence this order by adding "require" tags in the component declaration, to make sure it is resolved after another component. It will also impact the order in which contributions are registered on their target extension point (see "Registration Order" on contributions).

Components

Maven Artifact

File	nuxeo-automation-scripting-2023.22.13.jar
Group Id	org.nuxeo.ecm.automation
Artifact Id	nuxeo-automation-scripting
Version	2023.22.13

Manifest

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven 3.9.6
Built-By: root
Build-Jdk: 17.0.12
Bundle-ManifestVersion: 2
Bundle-Version: 2023.22.13-t20241121-011955
Bundle-Vendor: Nuxeo
Bundle-ActivationPolicy: lazy
Bundle-ClassPath: .
Bundle-Name: org.nuxeo.ecm.automation.scripting
Bundle-SymbolicName: org.nuxeo.ecm.automation.scripting
Nuxeo-Component: OSGI-INF/automation-scripting-service.xml,OSGI-INF/help
 ers-contrib.xml,OSGI-INF/classfilter-contrib.xml

Exports

Json Export Default Json serialization
Json Graph Json dependency graph
Json Contribution Stats Json statistics for contributions
CSV Contribution Stats CSV statistics for contributions

Charts

Raw Data: Json Contribution Stats

Contributions by Code Type

Loading data

Contributions by Target Extension Point

Loading data

Contributions by Studio Source

Loading data